Original: documenting a Spring Data REST API with Springfox and Swagger
With spring date REST, you can quickly create rest APIs for spring date repositories, and provide crud and more functionality. However, with the rigorous API
. Swagger UI adds a set of resources which you must configure as part of a class that extends Webmvcconfigureradapter, and is annotated with @EnableWebMvc. 2.3.VerificationTo verify that Springfox are working, you can visit the following URLs in your Browser:http://localhost:8080/spring-securit Y-rest/api/v2/api-docs T
About SwaggerSwagger can be one of the most popular rest APIs documentation generation tools for the following reasons:
Swagger can generate an interactive API console that developers can use to quickly learn and experiment with the API.
Swagger can generate cli
1 Working principleThere are more and more projects that are separated by the spring boot development front and back end, and the front and back ends are often the responsibility of different developers or teams. If the backend developed some rest interfaces, how can these interfaces be quickly and accurately described to front-end developers?Swagger provides a technical implementation of automatic scan gen
annotation and change the consumes to "application/x-www-form-urlencoded", for example:@ApiOperation(value="接口说明(测试)",httpMethod="GET",consumes="application/x-www-form-urlencoded",notes="在没有会话、没有签名的情况下,进入方法体")
So under what circumstances, the content type of the parameter is Application/json?
When you add a @requestbody annotation to the parameter, it means that this parameter receives JSON data, so you can write consumes as Application
Introduction
After the API development is done using ASP., writing the API documentation is a pain to the programmer, but the document must be written, and the document's format, if not specifically required, will depend entirely on the developer's mood. Or a little bit more, or simply. So is there a quick and efficient way to build API documentation? Th
This article mainly introduces the example of implementing the rest request api in python. if you need it, refer to the Sina python api for reference. it is applicable to open-source api requests.
The code is as follows:
#-*-Coding: UTF-8 -*-Import collectionsImport gzipI
", "Port": 00000002}], other element names see "Ryu Documentation" P282 actionsReturn result: integer, HTTP status code, 200 indicates success of adding flow table entryResults Example: 200,403,404#delete_flow_entry (dpid,match,priority,actions)Parameters:Dpid is a string, such as "0000000000000001"Match is a dictionary, such as match = {"In_port": 00000001}, the name of the other key is shown in "Ryu documentation" P161 Flow Match StructurePriority i
Installation of Swagger-editor
The YAML syntax applied by the
swagger-editor, with defined variables and data structures, does not understand that it is possible to refer to its example
installation steps:
download swagger-editor git address
shipping Line NPM Run build generates
Share a REST APIs document Framework swagger and apisswagger integrated in the project
1. Why is swagger used?
1-1 when a background developer develops an interface, do they need to re-write an interface document and submit it to the front-end developer, of course, what programmers do not like most is to write documents (of course, documents are necessary and con
front-end display, generally as follows:
1. Write the/** annotation in swagger format in PHP file * *
2. Use the Bin/swagger.phar command in swagger-php to scan the directory of PHP controller to generate Swagger.json files
3. Copy swagger.json file into Swagger-ui index.html specified directory
4. Open the URL where Swagger
If you use swagger to do restful documentation on your project, you can also generate client code from the code generator provided by swagger, while supporting feign clients.But after testing, generating feign code and Rest client is a bit bloated.Official website: Https://github.com/swagger-
=true, type="string" }; if(apidescription.actiondescriptor.getcustomattributes(). Any ()) {//if the API method is to allow anonymous methods, token is not requiredparameter.required=false; } operation.parameters.Add (parameter); } }2. Enable the authorization request header in SwaggerConfig.cs. Public Static voidRegister (httpconfiguration config) {varthisassembly =typeof(Swaggerconfig). Assembly; Config. Enable
:8080/swagger.json, and then click Enter to see our API description,What do we do if we want it to open by default when it's our API description? Replace Http://petstore.swagger.io/v2/swagger.json in file third_party/swagger-ui/index.html with http://localhost:8080/ Swagger.json, then regenerate the Pkg/ui/data/swagger
(); 45 46//Injection implementation Iswaggerprovider Use the default settings of the. Addswaggergen (); Configureswaggergen (Options =>50 {the options. Singleapiversion (new Info52 {Version = "V1", * * * "Test ASP.N ET Core WebAPIGenerate document (document description) ", Description =" A Simple example ASP. NET Core Web API ", Termsofser vice = "None", the page contact = new Contact {Name = "Linyongjie",
Https://github.com/swagger-api/swagger-ui get all of their dist directories into items that need to be integrated, this article is placed in the src/main/webapp/web-inf/swagger/directory.
Modifying the swagger/index.html file, by default, gets the JSON for the
Http://localhost:You can view the generated swagger UI by browsing Http://localhost:Each public action method in Todocontroller can be tested from the UI. Click a method name to expand the node. Add parameters, stand-alone "test"!4. Customization and ScalabilitySwagger provides the object model and custom UI for recording.API Info and DescriptionBy passing some information to Addswaggergen methods, such as author, license, and descriptionServices. Ad
still used this method to import the resource file. It's really powerless. But I learned something new ).
A slight modification was made to integrate Swagger-Ui into Swashbuckle. Core. The minor modification is as follows:
1
Solve the problem! The rest is the front-end work. You can customize it yourself. For example, if you are using the Chinese Language Pack,
The content source of this page is from Internet, which doesn't represent Alibaba Cloud's opinion;
products and services mentioned on that page don't have any relationship with Alibaba Cloud. If the
content of the page makes you feel confusing, please write us an email, we will handle the problem
within 5 days after receiving your email.
If you find any instances of plagiarism from the community, please send an email to:
info-contact@alibabacloud.com
and provide relevant evidence. A staff member will contact you within 5 working days.